<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.11.5" />
<title>pyboy.plugins.game_wrapper_kirby_dream_land API documentation</title>
<meta name="description" content="" />
<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:0.8em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script async src='https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS_CHTML'></script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>pyboy.plugins.game_wrapper_kirby_dream_land</code></h1>
</header>
<section id="section-intro">
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">#
# License: See LICENSE.md file
# GitHub: https://github.com/Baekalfen/PyBoy
#
__pdoc__ = {
    &#34;GameWrapperKirbyDreamLand.cartridge_title&#34;: False,
    &#34;GameWrapperKirbyDreamLand.post_tick&#34;: False,
}

import pyboy
from pyboy.utils import PyBoyException

from .base_plugin import PyBoyGameWrapper

logger = pyboy.logging.get_logger(__name__)


class GameWrapperKirbyDreamLand(PyBoyGameWrapper):
    &#34;&#34;&#34;
    This class wraps Kirby Dream Land, and provides easy access for AIs.

    If you call `print` on an instance of this object, it will show an overview of everything this object provides.
    &#34;&#34;&#34;

    cartridge_title = &#34;KIRBY DREAM LAN&#34;

    def __init__(self, *args, **kwargs):
        self.score = 0
        &#34;&#34;&#34;The score provided by the game&#34;&#34;&#34;
        self.health = 0
        &#34;&#34;&#34;The health provided by the game&#34;&#34;&#34;
        self.lives_left = 0
        &#34;&#34;&#34;The lives remaining provided by the game&#34;&#34;&#34;
        self._game_over = False
        &#34;&#34;&#34;The game over state&#34;&#34;&#34;

        super().__init__(*args, game_area_section=(0, 0, 20, 16), game_area_follow_scxy=True, **kwargs)

    def post_tick(self):
        self._tile_cache_invalid = True
        self._sprite_cache_invalid = True

        self.score = 0
        score_digits = 4
        for n in range(score_digits):
            self.score += self.pyboy.memory[0xD070 + n] * 10 ** (score_digits - n)

        # Check if game is over
        prev_health = self.health
        self.health = self.pyboy.memory[0xD086]
        if self.lives_left == 0:
            if prev_health &gt; 0 and self.health == 0:
                self._game_over = True

        self.lives_left = self.pyboy.memory[0xD089] - 1

    def start_game(self, timer_div=None):
        &#34;&#34;&#34;
        Call this function right after initializing PyBoy. This will navigate through menus to start the game at the
        first playable state.

        The state of the emulator is saved, and using `reset_game`, you can get back to this point of the game
        instantly.

        Kwargs:
            * timer_div (int): Replace timer&#39;s DIV register with this value. Use `None` to randomize.
        &#34;&#34;&#34;
        if self.game_has_started:
            raise PyBoyException(&#34;Gamewrapper already started! Use &#39;reset&#39; instead.&#34;)

        # Boot screen
        while True:
            self.pyboy.tick(1, False)
            if self.tilemap_background[0:3, 16] == [231, 224, 235]:  # &#39;HAL&#39; on the first screen
                break

        # Wait for transition to finish (start screen)
        self.pyboy.tick(25, False)
        self.pyboy.button(&#34;start&#34;)
        self.pyboy.tick()

        # Wait for transition to finish (exit start screen, enter level intro screen)
        self.pyboy.tick(60, False)

        # Skip level intro
        self.pyboy.button(&#34;start&#34;)
        self.pyboy.tick()

        # Wait for transition to finish (exit level intro screen, enter game)
        self.pyboy.tick(60, False)

        PyBoyGameWrapper.start_game(self, timer_div=timer_div)

    def reset_game(self, timer_div=None):
        &#34;&#34;&#34;
        After calling `start_game`, you can call this method at any time to reset the game.

        Kwargs:
            * timer_div (int): Replace timer&#39;s DIV register with this value. Use `None` to randomize.
        &#34;&#34;&#34;
        self._game_over = False
        PyBoyGameWrapper.reset_game(self, timer_div=timer_div)

    def game_area(self):
        &#34;&#34;&#34;
        Use this method to get a matrix of the &#34;game area&#34; of the screen.

        ```text
              0   1   2   3   4   5   6   7   8   9
          ____________________________________________________________________________________
          0  | 383 383 383 301 383 383 383 297 383 383 383 301 383 383 383 297 383 383 383 293
          1  | 383 383 383 383 300 294 295 296 383 383 383 383 300 294 295 296 383 383 299 383
          2  | 311 318 319 320 383 383 383 383 383 383 383 383 383 383 383 383 383 301 383 383
          3  | 383 383 383 321 322 383 383 383 383 383 383 383 383 383 383 383 383 383 300 294
          4  | 383 383 383 383 323 290 291 383 383 383 313 312 311 318 319 320 383 290 291 383
          5  | 383 383 383 383 324 383 383 383 383 315 314 383 383 383 383 321 322 383 383 383
          6  | 383 383 383 383 324 293 292 383 383 316 383 383 383 383 383 383 323 383 383 383
          7  | 383 383 383 383 324 383 383 298 383 317 383 383 383 383 383 383 324 383 383 383
          8  | 319 320 383 383 324 383 383 297 383 317 383 383 383 152 140 383 324 383 383 307
          9  | 383 321 322 383 324 294 295 296 383 325 383 383 383 383 383 383 326 272 274 309
          10 | 383 383 323 383 326 383 383 383 2   18  383 330 331 331 331 331 331 331 331 331
          11 | 274 383 324 272 274 272 274 272 274 272 274 334 328 328 328 328 328 328 328 328
          12 | 331 331 331 331 331 331 331 331 331 331 331 328 328 328 328 328 328 328 328 328
          13 | 328 328 328 277 278 328 328 328 328 328 328 328 328 277 278 328 328 277 278 277
          14 | 328 277 278 279 281 277 278 328 328 277 278 277 278 279 281 277 278 279 281 279
          15 | 278 279 281 280 282 279 281 277 278 279 281 279 281 280 282 279 281 280 282 280
        ```

        Returns
        -------
        memoryview:
            Simplified 2-dimensional memoryview of the screen
        &#34;&#34;&#34;
        return PyBoyGameWrapper.game_area(self)

    def game_over(self):
        return self._game_over

    def __repr__(self):
        return (
            &#34;Kirby Dream Land:\n&#34;
            + f&#34;Score: {self.score}\n&#34;
            + f&#34;Health: {self.health}\n&#34;
            + f&#34;Lives left: {self.lives_left}\n&#34;
            + super().__repr__()
        )</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="pyboy.plugins.game_wrapper_kirby_dream_land.GameWrapperKirbyDreamLand"><code class="flex name class">
<span>class <span class="ident">GameWrapperKirbyDreamLand</span></span>
<span>(</span><span>*args, **kwargs)</span>
</code></dt>
<dd>
<section class="desc"><p>This class wraps Kirby Dream Land, and provides easy access for AIs.</p>
<p>If you call <code>print</code> on an instance of this object, it will show an overview of everything this object provides.</p></section>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class GameWrapperKirbyDreamLand(PyBoyGameWrapper):
    &#34;&#34;&#34;
    This class wraps Kirby Dream Land, and provides easy access for AIs.

    If you call `print` on an instance of this object, it will show an overview of everything this object provides.
    &#34;&#34;&#34;

    cartridge_title = &#34;KIRBY DREAM LAN&#34;

    def __init__(self, *args, **kwargs):
        self.score = 0
        &#34;&#34;&#34;The score provided by the game&#34;&#34;&#34;
        self.health = 0
        &#34;&#34;&#34;The health provided by the game&#34;&#34;&#34;
        self.lives_left = 0
        &#34;&#34;&#34;The lives remaining provided by the game&#34;&#34;&#34;
        self._game_over = False
        &#34;&#34;&#34;The game over state&#34;&#34;&#34;

        super().__init__(*args, game_area_section=(0, 0, 20, 16), game_area_follow_scxy=True, **kwargs)

    def post_tick(self):
        self._tile_cache_invalid = True
        self._sprite_cache_invalid = True

        self.score = 0
        score_digits = 4
        for n in range(score_digits):
            self.score += self.pyboy.memory[0xD070 + n] * 10 ** (score_digits - n)

        # Check if game is over
        prev_health = self.health
        self.health = self.pyboy.memory[0xD086]
        if self.lives_left == 0:
            if prev_health &gt; 0 and self.health == 0:
                self._game_over = True

        self.lives_left = self.pyboy.memory[0xD089] - 1

    def start_game(self, timer_div=None):
        &#34;&#34;&#34;
        Call this function right after initializing PyBoy. This will navigate through menus to start the game at the
        first playable state.

        The state of the emulator is saved, and using `reset_game`, you can get back to this point of the game
        instantly.

        Kwargs:
            * timer_div (int): Replace timer&#39;s DIV register with this value. Use `None` to randomize.
        &#34;&#34;&#34;
        if self.game_has_started:
            raise PyBoyException(&#34;Gamewrapper already started! Use &#39;reset&#39; instead.&#34;)

        # Boot screen
        while True:
            self.pyboy.tick(1, False)
            if self.tilemap_background[0:3, 16] == [231, 224, 235]:  # &#39;HAL&#39; on the first screen
                break

        # Wait for transition to finish (start screen)
        self.pyboy.tick(25, False)
        self.pyboy.button(&#34;start&#34;)
        self.pyboy.tick()

        # Wait for transition to finish (exit start screen, enter level intro screen)
        self.pyboy.tick(60, False)

        # Skip level intro
        self.pyboy.button(&#34;start&#34;)
        self.pyboy.tick()

        # Wait for transition to finish (exit level intro screen, enter game)
        self.pyboy.tick(60, False)

        PyBoyGameWrapper.start_game(self, timer_div=timer_div)

    def reset_game(self, timer_div=None):
        &#34;&#34;&#34;
        After calling `start_game`, you can call this method at any time to reset the game.

        Kwargs:
            * timer_div (int): Replace timer&#39;s DIV register with this value. Use `None` to randomize.
        &#34;&#34;&#34;
        self._game_over = False
        PyBoyGameWrapper.reset_game(self, timer_div=timer_div)

    def game_area(self):
        &#34;&#34;&#34;
        Use this method to get a matrix of the &#34;game area&#34; of the screen.

        ```text
              0   1   2   3   4   5   6   7   8   9
          ____________________________________________________________________________________
          0  | 383 383 383 301 383 383 383 297 383 383 383 301 383 383 383 297 383 383 383 293
          1  | 383 383 383 383 300 294 295 296 383 383 383 383 300 294 295 296 383 383 299 383
          2  | 311 318 319 320 383 383 383 383 383 383 383 383 383 383 383 383 383 301 383 383
          3  | 383 383 383 321 322 383 383 383 383 383 383 383 383 383 383 383 383 383 300 294
          4  | 383 383 383 383 323 290 291 383 383 383 313 312 311 318 319 320 383 290 291 383
          5  | 383 383 383 383 324 383 383 383 383 315 314 383 383 383 383 321 322 383 383 383
          6  | 383 383 383 383 324 293 292 383 383 316 383 383 383 383 383 383 323 383 383 383
          7  | 383 383 383 383 324 383 383 298 383 317 383 383 383 383 383 383 324 383 383 383
          8  | 319 320 383 383 324 383 383 297 383 317 383 383 383 152 140 383 324 383 383 307
          9  | 383 321 322 383 324 294 295 296 383 325 383 383 383 383 383 383 326 272 274 309
          10 | 383 383 323 383 326 383 383 383 2   18  383 330 331 331 331 331 331 331 331 331
          11 | 274 383 324 272 274 272 274 272 274 272 274 334 328 328 328 328 328 328 328 328
          12 | 331 331 331 331 331 331 331 331 331 331 331 328 328 328 328 328 328 328 328 328
          13 | 328 328 328 277 278 328 328 328 328 328 328 328 328 277 278 328 328 277 278 277
          14 | 328 277 278 279 281 277 278 328 328 277 278 277 278 279 281 277 278 279 281 279
          15 | 278 279 281 280 282 279 281 277 278 279 281 279 281 280 282 279 281 280 282 280
        ```

        Returns
        -------
        memoryview:
            Simplified 2-dimensional memoryview of the screen
        &#34;&#34;&#34;
        return PyBoyGameWrapper.game_area(self)

    def game_over(self):
        return self._game_over

    def __repr__(self):
        return (
            &#34;Kirby Dream Land:\n&#34;
            + f&#34;Score: {self.score}\n&#34;
            + f&#34;Health: {self.health}\n&#34;
            + f&#34;Lives left: {self.lives_left}\n&#34;
            + super().__repr__()
        )</code></pre>
</details>
<h3>Ancestors</h3>
<ul class="hlist">
<li><a title="pyboy.plugins.base_plugin.PyBoyGameWrapper" href="base_plugin.html#pyboy.plugins.base_plugin.PyBoyGameWrapper">PyBoyGameWrapper</a></li>
<li>pyboy.plugins.base_plugin.PyBoyPlugin</li>
</ul>
<h3>Instance variables</h3>
<dl>
<dt id="pyboy.plugins.game_wrapper_kirby_dream_land.GameWrapperKirbyDreamLand.score"><code class="name">var <span class="ident">score</span></code></dt>
<dd>
<section class="desc"><p>The score provided by the game</p></section>
</dd>
<dt id="pyboy.plugins.game_wrapper_kirby_dream_land.GameWrapperKirbyDreamLand.health"><code class="name">var <span class="ident">health</span></code></dt>
<dd>
<section class="desc"><p>The health provided by the game</p></section>
</dd>
<dt id="pyboy.plugins.game_wrapper_kirby_dream_land.GameWrapperKirbyDreamLand.lives_left"><code class="name">var <span class="ident">lives_left</span></code></dt>
<dd>
<section class="desc"><p>The lives remaining provided by the game</p></section>
</dd>
</dl>
<h3>Methods</h3>
<dl>
<dt id="pyboy.plugins.game_wrapper_kirby_dream_land.GameWrapperKirbyDreamLand.start_game"><code class="name flex">
<span>def <span class="ident">start_game</span></span>(<span>self, timer_div=None)</span>
</code></dt>
<dd>
<section class="desc"><p>Call this function right after initializing PyBoy. This will navigate through menus to start the game at the
first playable state.</p>
<p>The state of the emulator is saved, and using <code>reset_game</code>, you can get back to this point of the game
instantly.</p>
<h2 id="kwargs">Kwargs</h2>
<ul>
<li>timer_div (int): Replace timer's DIV register with this value. Use <code>None</code> to randomize.</li>
</ul></section>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def start_game(self, timer_div=None):
    &#34;&#34;&#34;
    Call this function right after initializing PyBoy. This will navigate through menus to start the game at the
    first playable state.

    The state of the emulator is saved, and using `reset_game`, you can get back to this point of the game
    instantly.

    Kwargs:
        * timer_div (int): Replace timer&#39;s DIV register with this value. Use `None` to randomize.
    &#34;&#34;&#34;
    if self.game_has_started:
        raise PyBoyException(&#34;Gamewrapper already started! Use &#39;reset&#39; instead.&#34;)

    # Boot screen
    while True:
        self.pyboy.tick(1, False)
        if self.tilemap_background[0:3, 16] == [231, 224, 235]:  # &#39;HAL&#39; on the first screen
            break

    # Wait for transition to finish (start screen)
    self.pyboy.tick(25, False)
    self.pyboy.button(&#34;start&#34;)
    self.pyboy.tick()

    # Wait for transition to finish (exit start screen, enter level intro screen)
    self.pyboy.tick(60, False)

    # Skip level intro
    self.pyboy.button(&#34;start&#34;)
    self.pyboy.tick()

    # Wait for transition to finish (exit level intro screen, enter game)
    self.pyboy.tick(60, False)

    PyBoyGameWrapper.start_game(self, timer_div=timer_div)</code></pre>
</details>
</dd>
<dt id="pyboy.plugins.game_wrapper_kirby_dream_land.GameWrapperKirbyDreamLand.reset_game"><code class="name flex">
<span>def <span class="ident">reset_game</span></span>(<span>self, timer_div=None)</span>
</code></dt>
<dd>
<section class="desc"><p>After calling <code>start_game</code>, you can call this method at any time to reset the game.</p>
<h2 id="kwargs">Kwargs</h2>
<ul>
<li>timer_div (int): Replace timer's DIV register with this value. Use <code>None</code> to randomize.</li>
</ul></section>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def reset_game(self, timer_div=None):
    &#34;&#34;&#34;
    After calling `start_game`, you can call this method at any time to reset the game.

    Kwargs:
        * timer_div (int): Replace timer&#39;s DIV register with this value. Use `None` to randomize.
    &#34;&#34;&#34;
    self._game_over = False
    PyBoyGameWrapper.reset_game(self, timer_div=timer_div)</code></pre>
</details>
</dd>
<dt id="pyboy.plugins.game_wrapper_kirby_dream_land.GameWrapperKirbyDreamLand.game_area"><code class="name flex">
<span>def <span class="ident">game_area</span></span>(<span>self)</span>
</code></dt>
<dd>
<section class="desc"><p>Use this method to get a matrix of the "game area" of the screen.</p>
<pre><code class="language-text">      0   1   2   3   4   5   6   7   8   9
  ____________________________________________________________________________________
  0  | 383 383 383 301 383 383 383 297 383 383 383 301 383 383 383 297 383 383 383 293
  1  | 383 383 383 383 300 294 295 296 383 383 383 383 300 294 295 296 383 383 299 383
  2  | 311 318 319 320 383 383 383 383 383 383 383 383 383 383 383 383 383 301 383 383
  3  | 383 383 383 321 322 383 383 383 383 383 383 383 383 383 383 383 383 383 300 294
  4  | 383 383 383 383 323 290 291 383 383 383 313 312 311 318 319 320 383 290 291 383
  5  | 383 383 383 383 324 383 383 383 383 315 314 383 383 383 383 321 322 383 383 383
  6  | 383 383 383 383 324 293 292 383 383 316 383 383 383 383 383 383 323 383 383 383
  7  | 383 383 383 383 324 383 383 298 383 317 383 383 383 383 383 383 324 383 383 383
  8  | 319 320 383 383 324 383 383 297 383 317 383 383 383 152 140 383 324 383 383 307
  9  | 383 321 322 383 324 294 295 296 383 325 383 383 383 383 383 383 326 272 274 309
  10 | 383 383 323 383 326 383 383 383 2   18  383 330 331 331 331 331 331 331 331 331
  11 | 274 383 324 272 274 272 274 272 274 272 274 334 328 328 328 328 328 328 328 328
  12 | 331 331 331 331 331 331 331 331 331 331 331 328 328 328 328 328 328 328 328 328
  13 | 328 328 328 277 278 328 328 328 328 328 328 328 328 277 278 328 328 277 278 277
  14 | 328 277 278 279 281 277 278 328 328 277 278 277 278 279 281 277 278 279 281 279
  15 | 278 279 281 280 282 279 281 277 278 279 281 279 281 280 282 279 281 280 282 280
</code></pre>
<h2 id="returns">Returns</h2>
<dl>
<dt><code>memoryview:</code></dt>
<dd>Simplified 2-dimensional memoryview of the screen</dd>
</dl></section>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def game_area(self):
    &#34;&#34;&#34;
    Use this method to get a matrix of the &#34;game area&#34; of the screen.

    ```text
          0   1   2   3   4   5   6   7   8   9
      ____________________________________________________________________________________
      0  | 383 383 383 301 383 383 383 297 383 383 383 301 383 383 383 297 383 383 383 293
      1  | 383 383 383 383 300 294 295 296 383 383 383 383 300 294 295 296 383 383 299 383
      2  | 311 318 319 320 383 383 383 383 383 383 383 383 383 383 383 383 383 301 383 383
      3  | 383 383 383 321 322 383 383 383 383 383 383 383 383 383 383 383 383 383 300 294
      4  | 383 383 383 383 323 290 291 383 383 383 313 312 311 318 319 320 383 290 291 383
      5  | 383 383 383 383 324 383 383 383 383 315 314 383 383 383 383 321 322 383 383 383
      6  | 383 383 383 383 324 293 292 383 383 316 383 383 383 383 383 383 323 383 383 383
      7  | 383 383 383 383 324 383 383 298 383 317 383 383 383 383 383 383 324 383 383 383
      8  | 319 320 383 383 324 383 383 297 383 317 383 383 383 152 140 383 324 383 383 307
      9  | 383 321 322 383 324 294 295 296 383 325 383 383 383 383 383 383 326 272 274 309
      10 | 383 383 323 383 326 383 383 383 2   18  383 330 331 331 331 331 331 331 331 331
      11 | 274 383 324 272 274 272 274 272 274 272 274 334 328 328 328 328 328 328 328 328
      12 | 331 331 331 331 331 331 331 331 331 331 331 328 328 328 328 328 328 328 328 328
      13 | 328 328 328 277 278 328 328 328 328 328 328 328 328 277 278 328 328 277 278 277
      14 | 328 277 278 279 281 277 278 328 328 277 278 277 278 279 281 277 278 279 281 279
      15 | 278 279 281 280 282 279 281 277 278 279 281 279 281 280 282 279 281 280 282 280
    ```

    Returns
    -------
    memoryview:
        Simplified 2-dimensional memoryview of the screen
    &#34;&#34;&#34;
    return PyBoyGameWrapper.game_area(self)</code></pre>
</details>
</dd>
</dl>
<h3>Inherited members</h3>
<ul class="hlist">
<li><code><b><a title="pyboy.plugins.base_plugin.PyBoyGameWrapper" href="base_plugin.html#pyboy.plugins.base_plugin.PyBoyGameWrapper">PyBoyGameWrapper</a></b></code>:
<ul class="hlist">
<li><code><a title="pyboy.plugins.base_plugin.PyBoyGameWrapper.game_over" href="base_plugin.html#pyboy.plugins.base_plugin.PyBoyGameWrapper.game_over">game_over</a></code></li>
<li><code><a title="pyboy.plugins.base_plugin.PyBoyGameWrapper.mapping_one_to_one" href="base_plugin.html#pyboy.plugins.base_plugin.PyBoyGameWrapper.mapping_one_to_one">mapping_one_to_one</a></code></li>
<li><code><a title="pyboy.plugins.base_plugin.PyBoyGameWrapper.shape" href="base_plugin.html#pyboy.plugins.base_plugin.PyBoyGameWrapper.shape">shape</a></code></li>
</ul>
</li>
</ul>
</dd>
</dl>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="pyboy.plugins" href="index.html">pyboy.plugins</a></code></li>
</ul>
</li>
<li><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li>
<h4><code><a title="pyboy.plugins.game_wrapper_kirby_dream_land.GameWrapperKirbyDreamLand" href="#pyboy.plugins.game_wrapper_kirby_dream_land.GameWrapperKirbyDreamLand">GameWrapperKirbyDreamLand</a></code></h4>
<ul class="two-column">
<li><code><a title="pyboy.plugins.game_wrapper_kirby_dream_land.GameWrapperKirbyDreamLand.start_game" href="#pyboy.plugins.game_wrapper_kirby_dream_land.GameWrapperKirbyDreamLand.start_game">start_game</a></code></li>
<li><code><a title="pyboy.plugins.game_wrapper_kirby_dream_land.GameWrapperKirbyDreamLand.reset_game" href="#pyboy.plugins.game_wrapper_kirby_dream_land.GameWrapperKirbyDreamLand.reset_game">reset_game</a></code></li>
<li><code><a title="pyboy.plugins.game_wrapper_kirby_dream_land.GameWrapperKirbyDreamLand.game_area" href="#pyboy.plugins.game_wrapper_kirby_dream_land.GameWrapperKirbyDreamLand.game_area">game_area</a></code></li>
<li><code><a title="pyboy.plugins.game_wrapper_kirby_dream_land.GameWrapperKirbyDreamLand.score" href="#pyboy.plugins.game_wrapper_kirby_dream_land.GameWrapperKirbyDreamLand.score">score</a></code></li>
<li><code><a title="pyboy.plugins.game_wrapper_kirby_dream_land.GameWrapperKirbyDreamLand.health" href="#pyboy.plugins.game_wrapper_kirby_dream_land.GameWrapperKirbyDreamLand.health">health</a></code></li>
<li><code><a title="pyboy.plugins.game_wrapper_kirby_dream_land.GameWrapperKirbyDreamLand.lives_left" href="#pyboy.plugins.game_wrapper_kirby_dream_land.GameWrapperKirbyDreamLand.lives_left">lives_left</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.11.5</a>.</p>
</footer>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad()</script>
</body>
</html>
